DragStart(UIElement[],Point,Double,DragDropIndicatorSettings) Method

Called when the drag operation begins.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function DragStart( _
   ByVal dragElements() As UIElement, _
   ByVal mouseOffset As Point, _
   ByVal dragIndicatorOpacity As Double, _
   ByVal dragDropIndicatorSettings As DragDropIndicatorSettings _
) As Boolean

C#

public bool DragStart( 
   UIElement[] dragElements,
   Point mouseOffset,
   double dragIndicatorOpacity,
   DragDropIndicatorSettings dragDropIndicatorSettings
)

Parameters

dragElements

An array of UIElements that will be rendered onto the dragIndicator.

mouseOffset

The offset of the mouse into the drag Element. This will be used to position the Drag Control relative to the mouse.

dragIndicatorOpacity

The opacity of the drag indicator.

dragDropIndicatorSettings

The settings used to customized the display of the drop indicator

Return Value

True if a drag opeation was successfully started. False if it failed.

Remarks

This method is not used to being a Span Resize. Use DragSpanStart, instead.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2